#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

"""
PyMonkey is the Python API for Monkey.

Public classes:

  - :class:`MonkeyContext`:
      Main entry point for Monkey functionality.
  - :class:`RDD`:
      A Resilient Distributed Dataset (RDD), the basic abstraction in Monkey.
  - :class:`Broadcast`:
      A broadcast variable that gets reused across tasks.
  - :class:`Accumulator`:
      An "add-only" shared variable that tasks can only add values to.
  - :class:`MonkeyConf`:
      For configuring Monkey.
  - :class:`MonkeyFiles`:
      Access files shipped with jobs.
  - :class:`StorageLevel`:
      Finer-grained cache persistence levels.

"""

from pymonkey.conf import MonkeyConf
from pymonkey.context import MonkeyContext
from pymonkey.rdd import RDD
from pymonkey.files import MonkeyFiles
from pymonkey.storagelevel import StorageLevel
from pymonkey.accumulators import Accumulator, AccumulatorParam
from pymonkey.broadcast import Broadcast
from pymonkey.serializers import MarshalSerializer, PickleSerializer
from pymonkey.status import *
from pymonkey.profiler import Profiler, BasicProfiler


def since(version):
    """
    A decorator that annotates a function to append the version of Monkey the function was added.
    """
    import re
    indent_p = re.compile(r'\n( +)')

    def deco(f):
        indents = indent_p.findall(f.__doc__)
        indent = ' ' * (min(len(m) for m in indents) if indents else 0)
        f.__doc__ = f.__doc__.rstrip() + "\n\n%s.. versionadded:: %s" % (indent, version)
        return f
    return deco

__all__ = [
    "MonkeyConf", "MonkeyContext", "MonkeyFiles", "RDD", "StorageLevel", "Broadcast",
    "Accumulator", "AccumulatorParam", "MarshalSerializer", "PickleSerializer",
    "StatusTracker", "MonkeyJobInfo", "MonkeyStageInfo", "Profiler", "BasicProfiler",
]
